Skip to content

Conversation

anettkva
Copy link
Member

@anettkva anettkva commented Oct 2, 2026 •

Summary

Adds example data that shows how the data model is structured, and documents how AI was used to create it.

This PR also rewrites the root README for the first delivery. That was not part of the issue, but it is included here so the README can link to the example data.

Changes

Example data (docs/examples/)

  • 8 JSON files, one per entity in the data model: all 4 apparatus and all 22 element groups, plus a small set of elements, vaults, a variant group, a coach, gymnasts and routines
  • The elements, vaults, coach, gymnasts and routines are invented, and the data is for documentation only
  • A README in the folder explaining this
  • Link to the folder from docs/DATA_MODEL.md

AI usage (docs/AI_USAGE.md)

  • New section for the example data, including the prompt that was used

Root README (not planned in the issue)

  • Introduction, status, what to review, the dataset, planned functionality, technology and getting started
  • The "Working in this repository" section is unchanged

Known issue

not fixed here (discovered when writing 'getting started' readme)

pnpm test and pnpm build fail until pnpm-lock.yaml is updated, because Vitest was added with npm. We need to agree on pnpm or npm first.

Closes #14

@anettkva anettkva requested a review from a team as a code owner October 2, 2026 09:35
@anettkva anettkva linked an issue Oct 2, 2026 that may be closed by this pull request
3 tasks
Copy link
Member

@ronjalh ronjalh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ronjalh ronjalh merged commit 5ab2b9c into main Oct 2, 2026
@ronjalh ronjalh deleted the 14-add-mock-data-to-the-data-model-docs branch October 2, 2026 09:58
Sign in to join this conversation on GitHub.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add mock data to the data model docs
2 participants